package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendanceStatusAddDTO;
import org.jsola.hr.dto.AttendanceStatusUpdateDTO;
import org.jsola.hr.query.AttendanceStatusQuery;
import org.jsola.hr.vo.AttendanceStatusListVO;
import org.jsola.hr.vo.AttendanceStatusVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-员工考勤状态")
public interface IAttendanceStatusControllerAPI {

    /**
     * 新增员工考勤状态
     * @param attendanceStatusAddDTO 员工考勤状态新增实体
     * @return 员工考勤状态展示对象
     */
    @ApiOperation(value = "新增员工考勤状态")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusAddDTO", dataType = "AttendanceStatusAddDTO", value = "新增员工考勤状态", paramType = "body")
    })
    Result<AttendanceStatusVO> save(AttendanceStatusAddDTO attendanceStatusAddDTO);


    /**
     * 修改员工考勤状态
     * @param attendanceStatusUpdateDTO 员工考勤状态
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工考勤状态")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusUpdateDTO", dataType = "AttendanceStatusUpdateDTO", value = "修改员工考勤状态", paramType = "body")
    })
    Result<Integer> update(AttendanceStatusUpdateDTO attendanceStatusUpdateDTO);




    /**
     * 删除单个员工考勤状态，彻底删除
     * @param attendanceStatusId 员工考勤状态id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工考勤状态，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusId", dataType = "String", value = "员工考勤状态id", paramType = "path")
    })
    Result<Integer> delete(String attendanceStatusId);


    /**
     * 批量删除员工考勤状态，彻底删除
     * @param attendanceStatusIds 员工考勤状态id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工考勤状态，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusIds", dataType = "String[]", value = "员工考勤状态id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendanceStatusIds);


    /**
     * 根据员工考勤状态id查询员工考勤状态详情
     * @param attendanceStatusId 员工考勤状态id
     * @return 员工考勤状态详情
     */
    @ApiOperation(value="根据员工考勤状态id查询员工考勤状态详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusId", dataType = "String", value = "员工考勤状态id", paramType = "path")
    })
    Result<AttendanceStatusVO> findById(String attendanceStatusId);


    /**
     * 查询员工考勤状态
     * @param attendanceStatusQuery 员工考勤状态查询参数
     * @return page
     */
    @ApiOperation(value="查询员工考勤状态")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusQuery", dataType = "AttendanceStatusQuery", value = "员工考勤状态查询参数", paramType = "query")
    })
    Result<List<AttendanceStatusListVO>> listAll(AttendanceStatusQuery attendanceStatusQuery);


     /**
     * 分页查询员工考勤状态
     * @param attendanceStatusQuery 员工考勤状态查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工考勤状态")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceStatusQuery", dataType = "AttendanceStatusQuery", value = "员工考勤状态查询参数", paramType = "query")
    })
    Result<Page<AttendanceStatusListVO>> page(AttendanceStatusQuery attendanceStatusQuery);


}

